com.inscoper.api.ParamDescription

ParamDescription class provides parameter information coming from drivers. More...

Public Functions

	Name
synchronized void	delete()
int	getTag() Get the tag of the parameter.
String	getName() Get the name of the parameter.
String	getDescription() Get the description of the parameter.
EParamType	getType() Get the type of the parameter.
Constraint	getConstraint() Get the constraints of the parameter.

Protected Functions

	Name
	ParamDescription(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(ParamDescription obj)

Detailed Description

public class com.inscoper.api.ParamDescription;

ParamDescription class provides parameter information coming from drivers.

Note: This class is non-copyable and non-movable.

This class is an abstract base class storing device parameters, including their tag, name, description, and type.

Public Functions Documentation

function delete

public synchronized void delete()

function getTag

public int getTag()

Get the tag of the parameter.

Return: The tag of the parameter

Retrieves the unique tag of the parameter.

function getName

public String getName()

Get the name of the parameter.

Return: The name of the parameter

Retrieves the display name of the parameter.

function getDescription

public String getDescription()

Get the description of the parameter.

Return: The description of the parameter

Retrieves the textual description of the parameter.

function getType

public EParamType getType()

Get the type of the parameter.

Return: The type of the parameter

Retrieves the data type of the parameter.

function getConstraint

public Constraint getConstraint()

Get the constraints of the parameter.

Return: The constraint of the parameter

Retrieves the constraints of the parameter (e.g. min, max, step size).

Protected Functions Documentation

function ParamDescription

protected ParamDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

function finalize

protected void finalize()

function getCPtr

protected static long getCPtr(
    ParamDescription obj
)

---

Updated on 2026-04-02 at 10:55:38 +0200